<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>websocket::stream::accept (5 of 6 overloads)</title>
<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../../../index.html" title="Chapter&#160;1.&#160;Boost.Beast">
<link rel="up" href="../accept.html" title="websocket::stream::accept">
<link rel="prev" href="overload4.html" title="websocket::stream::accept (4 of 6 overloads)">
<link rel="next" href="overload6.html" title="websocket::stream::accept (6 of 6 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload4.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../accept.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload6.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h6 class="title">
<a name="beast.ref.boost__beast__websocket__stream.accept.overload5"></a><a class="link" href="overload5.html" title="websocket::stream::accept (5 of 6 overloads)">websocket::stream::accept
          (5 of 6 overloads)</a>
</h6></div></div></div>
<p>
            Respond to a WebSocket HTTP Upgrade request.
          </p>
<h7><a name="beast.ref.boost__beast__websocket__stream.accept.overload5.h0"></a>
            <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.accept.overload5.synopsis"></a></span><a class="link" href="overload5.html#beast.ref.boost__beast__websocket__stream.accept.overload5.synopsis">Synopsis</a>
          </h7><pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
    <span class="keyword">class</span> <a class="link" href="../../../concepts/Body.html" title="Body"><span class="bold"><strong>Body</strong></span></a><span class="special">,</span>
    <span class="keyword">class</span> <span class="identifier">Allocator</span><span class="special">&gt;</span>
<span class="keyword">void</span>
<span class="identifier">accept</span><span class="special">(</span>
    <span class="identifier">http</span><span class="special">::</span><span class="identifier">request</span><span class="special">&lt;</span> <span class="identifier">Body</span><span class="special">,</span> <span class="identifier">http</span><span class="special">::</span><span class="identifier">basic_fields</span><span class="special">&lt;</span> <span class="identifier">Allocator</span> <span class="special">&gt;&gt;</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">req</span><span class="special">);</span>
</pre>
<h7><a name="beast.ref.boost__beast__websocket__stream.accept.overload5.h1"></a>
            <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.accept.overload5.description"></a></span><a class="link" href="overload5.html#beast.ref.boost__beast__websocket__stream.accept.overload5.description">Description</a>
          </h7><p>
            This function is used to synchronously send the HTTP response to an HTTP
            request possibly containing a WebSocket Upgrade. The call blocks until
            one of the following conditions is true:
          </p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
                The response finishes sending.
              </li>
<li class="listitem">
                An error occurs on the stream.
              </li>
</ul></div>
<p>
            This function is implemented in terms of one or more calls to the next
            layer's <code class="computeroutput"><span class="identifier">read_some</span></code> and
            <code class="computeroutput"><span class="identifier">write_some</span></code> functions.
          </p>
<p>
            If the stream receives a valid HTTP WebSocket Upgrade request, an HTTP
            response is sent back indicating a successful upgrade. When this call
            returns, the stream is then ready to send and receive WebSocket protocol
            frames and messages. If the HTTP Upgrade request is invalid or cannot
            be satisfied, an HTTP response is sent indicating the reason and status
            code (typically 400, "Bad Request"). This counts as a failure.
          </p>
<h7><a name="beast.ref.boost__beast__websocket__stream.accept.overload5.h2"></a>
            <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.accept.overload5.parameters"></a></span><a class="link" href="overload5.html#beast.ref.boost__beast__websocket__stream.accept.overload5.parameters">Parameters</a>
          </h7><div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                    <p>
                      Name
                    </p>
                  </th>
<th>
                    <p>
                      Description
                    </p>
                  </th>
</tr></thead>
<tbody><tr>
<td>
                    <p>
                      <code class="computeroutput"><span class="identifier">req</span></code>
                    </p>
                  </td>
<td>
                    <p>
                      An object containing the HTTP Upgrade request. Ownership is
                      not transferred, the implementation will not access this object
                      from other threads.
                    </p>
                  </td>
</tr></tbody>
</table></div>
<h7><a name="beast.ref.boost__beast__websocket__stream.accept.overload5.h3"></a>
            <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.accept.overload5.exceptions"></a></span><a class="link" href="overload5.html#beast.ref.boost__beast__websocket__stream.accept.overload5.exceptions">Exceptions</a>
          </h7><div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                    <p>
                      Type
                    </p>
                  </th>
<th>
                    <p>
                      Thrown On
                    </p>
                  </th>
</tr></thead>
<tbody><tr>
<td>
                    <p>
                      <code class="computeroutput"><span class="identifier">system_error</span></code>
                    </p>
                  </td>
<td>
                    <p>
                      Thrown on failure.
                    </p>
                  </td>
</tr></tbody>
</table></div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2016, 2017 Vinnie Falco<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload4.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../accept.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload6.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
